home *** CD-ROM | disk | FTP | other *** search
/ IRIX Base Documentation 2002 November / SGI IRIX Base Documentation 2002 November.iso / usr / share / catman / p_man / cat3dm / audiofile / AFinitmiscids.z / AFinitmiscids
Encoding:
Text File  |  2002-10-03  |  9.2 KB  |  199 lines

  1.  
  2.  
  3.  
  4. aaaaffffIIIInnnniiiittttMMMMiiiissssccccIIIIDDDDssss((((3333ddddmmmm))))                                          aaaaffffIIIInnnniiiittttMMMMiiiissssccccIIIIDDDDssss((((3333ddddmmmm))))
  5.  
  6.  
  7.  
  8. NNNNAAAAMMMMEEEE
  9.      afInitMiscIDs, afInitMiscType, afInitMiscSize - initialize the list of
  10.      miscellaneous data chunk ID's in an AAAAFFFFffffiiiilllleeeesssseeeettttuuuupppp file configuration
  11.      structure, initialize the chunk type and number of data bytes for a given
  12.      miscellaneous chunk.
  13.  
  14. SSSSYYYYNNNNOOOOPPPPSSSSIIIISSSS
  15.      ####iiiinnnncccclllluuuuddddeeee <<<<ddddmmmmeeeeddddiiiiaaaa////aaaauuuuddddiiiiooooffffiiiilllleeee....hhhh>>>>
  16.  
  17.      vvvvooooiiiidddd aaaaffffIIIInnnniiiittttMMMMiiiissssccccIIIIDDDDssss((((AAAAFFFFffffiiiilllleeeesssseeeettttuuuupppp sssseeeettttuuuupppp,,,, iiiinnnntttt mmmmiiiisssscccciiiiddddssss[[[[]]]],,,, iiiinnnntttt nnnnmmmmiiiisssscccc))))
  18.  
  19.      vvvvooooiiiidddd aaaaffffIIIInnnniiiittttMMMMiiiissssccccTTTTyyyyppppeeee((((AAAAFFFFffffiiiilllleeeesssseeeettttuuuupppp sssseeeettttuuuupppp,,,, iiiinnnntttt cccchhhhuuuunnnnkkkkiiiidddd,,,, iiiinnnntttt ttttyyyyppppeeee))))
  20.  
  21.      vvvvooooiiiidddd aaaaffffIIIInnnniiiittttMMMMiiiissssccccSSSSiiiizzzzeeee((((AAAAFFFFffffiiiilllleeeesssseeeettttuuuupppp sssseeeettttuuuupppp,,,, iiiinnnntttt cccchhhhuuuunnnnkkkkiiiidddd,,,, iiiinnnntttt ssssiiiizzzzeeee))))
  22.  
  23. PPPPAAAARRRRAAAAMMMMEEEETTTTEEEERRRR
  24.      _s_e_t_u_p  is an AAAAFFFFffffiiiilllleeeesssseeeettttuuuupppp structure, previously created by a call to
  25.             aaaaffffNNNNeeeewwwwFFFFiiiilllleeeeSSSSeeeettttuuuupppp(((()))).
  26.  
  27.      _m_i_s_c_i_d_s
  28.             is an array of (unique) positive integer ID's which are used to
  29.             reference miscellaneous data chunks in a new audio file after it
  30.             is created by passing _s_e_t_u_p to aaaaffffOOOOppppeeeennnnFFFFiiiilllleeee(3dm).
  31.  
  32.      _n_m_i_s_c  The total number of miscellaneous chunks in the file
  33.             configuration.  See the audio file format man pages aaaaiiiiffffcccc(4),
  34.             nnnneeeexxxxtttt(4), wwwwaaaavvvveeee(4), bbbbiiiiccccssssffff(4), and ssssoooouuuunnnnddddddddeeeessssiiiiggggnnnneeeerrrr2222(4) for format-
  35.             specific information.
  36.  
  37.      _c_h_u_n_k_i_d
  38.             is one of the chunk ID's from the _m_i_s_c_i_d_s list.
  39.  
  40.      _t_y_p_e   is an integer constant which denotes a valid chunk type for the
  41.             file format being configured with _s_e_t_u_p.
  42.  
  43.      _s_i_z_e   is a nonnegative integer value indicating the number of bytes to
  44.             be allocated in the file header for data in the chunk given by
  45.             _c_h_u_n_k_i_d.
  46.  
  47. DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNN
  48.      aaaaffffIIIInnnniiiittttMMMMiiiissssccccIIIIDDDDssss(((()))) initializes a list of unique miscellaneous chunk ID's
  49.      which are used to reference various file format dependent data chunks in
  50.      an audio file created by passing _s_e_t_u_p to aaaaffffOOOOppppeeeennnnFFFFiiiilllleeee(3dm).
  51.  
  52.      After you specify the list of ID's, you have to specify a chunk type and
  53.      a chunk data area size for each of the ID's by calling aaaaffffIIIInnnniiiittttMMMMiiiissssccccTTTTyyyyppppeeee(((())))
  54.      and aaaaffffIIIInnnniiiittttMMMMiiiissssccccSSSSiiiizzzzeeee(((()))).
  55.  
  56.      The current valid miscellaneous data types are:
  57.  
  58.  
  59.  
  60.  
  61.  
  62.  
  63.                                                                         PPPPaaaaggggeeee 1111
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70. aaaaffffIIIInnnniiiittttMMMMiiiissssccccIIIIDDDDssss((((3333ddddmmmm))))                                          aaaaffffIIIInnnniiiittttMMMMiiiissssccccIIIIDDDDssss((((3333ddddmmmm))))
  71.  
  72.  
  73.  
  74.      AAAAFFFF____MMMMIIIISSSSCCCC____CCCCOOOOPPPPYYYY      Copyright string
  75.  
  76.      AAAAFFFF____MMMMIIIISSSSCCCC____AAAAUUUUTTTTHHHH      Author/artist string
  77.  
  78.      AAAAFFFF____MMMMIIIISSSSCCCC____NNNNAAAAMMMMEEEE      Name string
  79.  
  80.      AAAAFFFF____MMMMIIIISSSSCCCC____AAAANNNNNNNNOOOO      AIFF/AIFF-C annotation string
  81.  
  82.      AAAAFFFF____MMMMIIIISSSSCCCC____MMMMIIIIDDDDIIII      AIFF/AIFF-C MIDI system exclusive data
  83.  
  84.      AAAAFFFF____MMMMIIIISSSSCCCC____AAAAPPPPPPPPLLLL      AIFF/AIFF-C application-specific data
  85.  
  86.      AAAAFFFF____MMMMIIIISSSSCCCC____PPPPCCCCMMMMMMMMAAAAPPPP    PCM mapping information (for future use)
  87.  
  88.      AAAAFFFF____MMMMIIIISSSSCCCC____NNNNeeeeXXXXTTTT      NeXT file info chunk
  89.  
  90.      AAAAFFFF____MMMMIIIISSSSCCCC____IIIIRRRRCCCCAAAAMMMM____PPPPEEEEAAAAKKKKAAAAMMMMPPPP
  91.                        BICSF peak amplitude sfcode
  92.  
  93.      AAAAFFFF____MMMMIIIISSSSCCCC____CCCCOOOOMMMMMMMMEEEENNNNTTTT   Text comment string.  The tags AAAAFFFF____MMMMIIIISSSSCCCC____IIIIRRRRCCCCAAAAMMMM____CCCCOOOOMMMMMMMMEEEENNNNTTTT
  94.                        and AAAAFFFF____MMMMIIIISSSSCCCC____IIIICCCCMMMMTTTT are also allowed for this type, though
  95.                        this chunk is supported by several file types.
  96.  
  97.      AAAAFFFF____MMMMIIIISSSSCCCC____IIIICCCCRRRRDDDD      Creation date string.  This is usually of the form
  98.                        "YYYY-MM-DD".
  99.  
  100.      AAAAFFFF____MMMMIIIISSSSCCCC____IIIISSSSFFFFTTTT      Software name string.  Usually set to the name of the
  101.                        software package which created the sound.
  102.  
  103.      AAAAFFFF____MMMMIIIISSSSCCCC____UUUUNNNNRRRREEEECCCCOOOOGGGGNNNNIIIIZZZZEEEEDDDD
  104.                        unrecognized data chunk
  105.  
  106.      For AIFF-C (and AIFF) files, you do not need to worry about the "trailing
  107.      zero pad byte" required at the end of chunks with odd numbers of data
  108.      bytes.  The library hides this implementation detail from applications.
  109.  
  110.      When an application creates an audio file by passing _s_e_t_u_p to
  111.      aaaaffffOOOOppppeeeennnnFFFFiiiilllleeee(3dm), the header for the file is written out with zero-filled
  112.      areas reserved for each of the various requested miscellaneous data
  113.      types.
  114.  
  115.      You use the routine aaaaffffWWWWrrrriiiitttteeeeMMMMiiiisssscccc(3dm) to write data into the chunks after
  116.      the file has be opened.  The application is responsible for managing the
  117.      contents of the header space reserved for each chunk of miscellaneous
  118.      data.
  119.  
  120.      For example, if the application reserves 1000 bytes of space for MIDI
  121.      exclusive data, then the application needs make sure that any bytes which
  122.      aren't used for meaningful data are filled with MIDI no-op messages
  123.      instead.
  124.  
  125.  
  126.  
  127.  
  128.  
  129.                                                                         PPPPaaaaggggeeee 2222
  130.  
  131.  
  132.  
  133.  
  134.  
  135.  
  136. aaaaffffIIIInnnniiiittttMMMMiiiissssccccIIIIDDDDssss((((3333ddddmmmm))))                                          aaaaffffIIIInnnniiiittttMMMMiiiissssccccIIIIDDDDssss((((3333ddddmmmm))))
  137.  
  138.  
  139.  
  140. CCCCAAAAVVVVEEEEAAAATTTTSSSS
  141.      The Audio File Library will continue to expand the number of supported
  142.      file formats and misc types.  The ability of these file formats to store
  143.      various kinds and numbers of miscellaneous chunks will vary.  See
  144.      aaaaffffGGGGeeeettttMMMMiiiissssccccIIIIDDDDssss(3dm) for some important notes about handling this situation.
  145.  
  146. SSSSEEEEEEEE AAAALLLLSSSSOOOO
  147.      afNewFileSetup(3dm), afOpenFile(3dm), afWriteMisc(3dm)
  148.  
  149.  
  150.  
  151.  
  152.  
  153.  
  154.  
  155.  
  156.  
  157.  
  158.  
  159.  
  160.  
  161.  
  162.  
  163.  
  164.  
  165.  
  166.  
  167.  
  168.  
  169.  
  170.  
  171.  
  172.  
  173.  
  174.  
  175.  
  176.  
  177.  
  178.  
  179.  
  180.  
  181.  
  182.  
  183.  
  184.  
  185.  
  186.  
  187.  
  188.  
  189.  
  190.  
  191.  
  192.  
  193.  
  194.  
  195.                                                                         PPPPaaaaggggeeee 3333
  196.  
  197.  
  198.  
  199.